Create or update a batch of Recommend Rules

Each Recommend Rule is created or updated, depending on whether a Recommend Rule with the same `objectID` already exists.
You may also specify `true` for `clearExistingRules`, in which case the batch will atomically replace all the existing Recommend Rules.

Recommend Rules are similar to Search Rules, except that the conditions and consequences apply to a [source item](/doc/guides/algolia-recommend/overview/#recommend-models) instead of a query. The main differences are the following:
- Conditions `pattern` and `anchoring` are unavailable.
- Condition `filters` triggers if the source item matches the specified filters.
- Condition `filters` accepts numeric filters.
- Consequence `params` only covers filtering parameters.
- Consequence `automaticFacetFilters` doesn't require a facet value placeholder (it tries to match the data source item's attributes instead).


Create or update a batch of Recommend Rules

Facet attribute. Only recommendations with the same value (or only recommendations with a different value) as the original viewed item are included.

Whether the filter is negative.
If true, recommendations must not have the same value for the `facet` attribute.
If false, recommendations must have the same value for the `facet` attribute.


Condition that triggers the rule.
If not specified, the rule is triggered for all recommendations.


Object ID of the recommendation you want to exclude.

Filter or boost recommendations matching a facet filter.

Filter recommendations that match or don't match the same `facet:facet_value` combination as the viewed item.

Filters to promote or demote records in the search results.

Optional filters work like facet filters, but they don't exclude records from the search results.
Records that match the optional filter rank before records that don't match.
Matches with higher weights (`<score=N>`) rank before matches with lower weights.
If you're using a negative filter `facet:-value`, matching records rank after records that don't match.


Place items at specific positions in the list of recommendations.

Object ID and position of the recommendation you want to pin.

Index in the list of recommendations where to place this item.

An additional restriction that only triggers the rule, when the search has the same value as `ruleContexts` parameter.
For example, if `context: mobile`, the rule is only triggered when the search request has a matching `ruleContexts: mobile`.
A rule context must only contain alphanumeric characters.


Filter expression to only include items that match the filter criteria in the response.

You can use these filter expressions:

- **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`.
- **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive).
- **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value.
- **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive).
- **Boolean filters.** `<facet>: true | false`.

You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:

- You can only combine filters of the same type with `OR`.
  **Not supported:** `facet:value OR num > 3`.
- You can't use `NOT` with combinations of filters.
  **Not supported:** `NOT(facet:value OR facet:value)`
- You can't combine conjunctions (`AND`) with `OR`.
  **Not supported:** `facet:value OR (facet:value AND facet:value)`

Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes.
If a facet attribute is an array, the filter matches if it matches at least one element of the array.

For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).


objectID

Unique identifier of a task.

A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.


When the rule should start to be active, in Unix epoch time.

When the rule should stop to be active, in Unix epoch time.

Date and time when the object was updated, in RFC 3339 format.

rules

appId & apiKey

Algolia docs

Algolia is a platform for building powerful end-to-end search and discovery solutions.

Home

Algolia documentation

A short, step-by-step guide to learn Algolia basics.

Algolia Launchpad

Get Started with Launchpad

Create your first index and add records to make searchable in the next steps.

Import Your Data

Imorting Data

Build your search interface using the data you recently pushed to your Algolia index.

Design Your Results

Allow your users to search through your data based on the attributes you define here.

Add Searchable Attributes

Adding Searchable Attributes

Determine how your search results should be ranked based on index attributes and objectives.

Configure Relevancy

Configuring Search Relevancy

Create your search interface leveraging Algolia InstantSearch library.

Implement Search UI

Implement Search

Learn what Algolia's search API offers: speed, relevance, search, navigation, product and content discovery, and analytics.

What is Algolia?

NeuralSearch combines the precision of keyword matching with the deep understanding of natural language and contextual relevance provided by AI-based vector search.

NeuralSearch

Learn about the building blocks of Algolia's search engine, what Algolia offers, and the full ecosystem it provides.

How Algolia works

An overview of Algolia's ecosystem. API clients, UI libraries, integrations, the dashboard, and more.

Algolia's ecosystem

Learn how you can elevate your search and discovery experience with Algolia's out-of-the-box features.

Algolia's features

Terms used at Algolia and their definitions.

Algolia glossary

Unlock Algolia's most powerful features by collecting user events with the Insights API.

Get started

Get started with click and conversion events

How to send your data to Algolia, batch large datasets, synchronize with incremental updates and atomic reindexing, or handle concurrency.

Send and update your data

Relevancy from a high-level point of view - finding records, ranking, tie-breaking, typos, and other settings.

Relevance overview

Learn how you can use Algolia Recommend to display recommendations on your site or app.

Algolia Recommend

Use AI to automate finding the best synonyms for your search.

Dynamic Synonym Suggestions

Predict the categories to which a search query belongs with AI.

Query Categorization

Dynamic Re-Ranking automatically adjusts your ranking based on user trends.

Dynamic Re-Ranking

Learn how to use Dynamic Re-Ranking to re-rank and promote popular products on category pages.

Add Dynamic Re-Ranking to category pages

Overview

Python API client

Open source libraries for building search and discovery interfaces.

Autocomplete is an open source, production-ready JavaScript library for building search and discovery experiences.

API reference

Create or update a batch of Recommend Rules

Authorizations

Path Parameters

Body

Response